Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs update #575

Merged
merged 5 commits into from
Mar 2, 2022
Merged

docs update #575

merged 5 commits into from
Mar 2, 2022
+95 −16

Conversation

rachmadaniHaryono
Copy link
Collaborator

  • update for documentation using sphinx
  • package is based from poetry
  • modules is based from sphinx-apidoc
  • python file is formatted with darker

related #484 (comment)

> # install required package
> pip install -e ".[docs]"
> # clone buku wiki
> git clone https://github.com/jarun/buku.wiki.git docs/source/wiki
> # build documentation
> sphinx-build docs/source build
> xdg-open build/index.html

i said to try mkdocs but there is also problem with it

https://github.com/rachmadaniHaryono/Buku/tree/feature/mkdocs

i haven't going too deep to it but i may not continue it if sphinx can be used

i still don't know how to upload it to github page or readthedocs

@rachmadaniHaryono rachmadaniHaryono changed the title build(setup): docs docs update Mar 1, 2022
@froschdesign
Copy link

i still don't know how to upload it to github page…

No "upload" needed: https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site

@rachmadaniHaryono
Copy link
Collaborator Author

@froschdesign thanks for that

i tried it once again manually and it work https://rachmadaniharyono.github.io/Buku/index.html

after set up gh-branch, move build files to that branch and commit it as usual

maybe there is better way to run it automatically with github action

@froschdesign
Copy link

maybe there is better way to run it automatically with github action

https://github.com/marketplace?type=actions&query=sphinx+

@rachmadaniHaryono
Copy link
Collaborator Author

rachmadaniHaryono commented Mar 1, 2022 •
edited
Loading

i only tried this and failed https://github.com/marketplace/actions/sphinx-to-github-pages

i still have to try others on that list

@jarun
Copy link
Owner

jarun commented Mar 1, 2022

Please let me know when it's ready and I'll merge.

@rachmadaniHaryono
Copy link
Collaborator Author

@jarun it is ready

github action can be added on another pr

@jarun jarun merged commit 73df4ce into jarun:master Mar 2, 2022
@jarun
Copy link
Owner

jarun commented Mar 2, 2022

Thank you!

@github-actions github-actions bot locked and limited conversation to collaborators Apr 2, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@rachmadaniHaryono @froschdesign @jarun